docs: Update for comprehensive coverage and fix formatting#2
Merged
aaronstevenwhite merged 1 commit intomainfrom Feb 10, 2026
Merged
docs: Update for comprehensive coverage and fix formatting#2aaronstevenwhite merged 1 commit intomainfrom
aaronstevenwhite merged 1 commit intomainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Comprehensive documentation update to fix rendering issues and reflect the current state of the bead codebase.
Formatting fixes:
architecture.md-- bold module headers were missing blank line separators, causing lists to render as inline text instead of bullet lists (14 sections fixed)uv run uv runcommands intesting.mdNew API reference pages (6):
bead.simulation-- annotators, noise models, task-specific strategiesbead.evaluation-- convergence detection, inter-annotator agreementbead.dsl-- constraint expression parser, evaluator, stdlib, ASTbead.behavioral-- judgment analytics, extraction, mergingbead.participants-- participant metadata models and collectionsbead.data_collection-- JATOS and Prolific data retrievalExpanded existing API pages with adapter coverage:
items.md-- 9 model adapter entries (OpenAI, Anthropic, Google, HuggingFace, TogetherAI, etc.)resources.md-- 5 resource adapter entries (Glazing, UniMorph, etc.)templates.md-- 3 template adapter entries (HuggingFace MLM, etc.)Content corrections:
architecture.md(14 -> 17 modules)model_metrics.py,cross_validation.py) from evaluation section that don't exist in codebasebehavioral/,participants/,tokenization/architecture.md,index.md,concepts.mdmkdocs.ymlnavigationMotivation
Documentation was stale relative to the codebase -- several modules added since initial docs generation had no API reference pages, module counts were wrong, and list formatting was broken in the architecture page.
Type of Change
Checklist
uv run ruff check .anduv run ruff format .uv run pyrightwith no errorsuv run pytest tests/)Testing
mkdocs buildcompletes with no errors (only pre-existing griffe warnings from Pydantic model docstrings)Screenshots (if applicable)
N/A